Skip to content

Retrieve Hub privacy state

Request

Lists all available methods for restricting access to the Hub as well as the currently enabled access restriction method or public if Hub is public.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/access_restriction?api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
allowed_methodsArray of strings
Items Enum:"saml""google_oauth""global_password""public"
Example:
[
  "saml",
  "google_oauth",
  "global_password",
  "public"
]
enabled_methodstring
Enum:"saml""google_oauth""global_password""public"
Response
{
  "allowed_methods": [
    "saml",
    "google_oauth",
    "global_password",
    "public"
  ],
  "enabled_method": "saml"
}